Add private endpoint management tips. by ginkgoch · Pull Request #23612 · pingcap/docs

ginkgoch · 2026-08-26T06:35:37Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added or deleted? (Required)

The private endpoint guide missed some tips for how we manage the private endpoints, add those tips for dedicated and premium.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s):

AI agent involvement

The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

Summary by CodeRabbit

Documentation
- Clarified that private endpoints are shared resources and may be reused by compatible instances or clusters.
- Documented that endpoints remain available after the associated instance or cluster is deleted.
- Added lifecycle guidance: unused endpoints are automatically removed after 30 days.
- Clarified that endpoints cannot be deleted while they are still in use.
- Specified the applicable resource scope for each deployment type: tenant-level or project-level.

coderabbitai · 2026-08-26T06:36:43Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 66afddfb-f42c-43ac-aefa-d2b523dd0b4f

📥 Commits

Reviewing files that changed from the base of the PR and between 894b7e4 and ae0ae78.

📒 Files selected for processing (1)

tidb-cloud/premium/set-up-sink-private-endpoint-premium.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

Walkthrough

The documentation now describes private endpoint scope, sharing, persistence after resource deletion, deletion restrictions, and automatic cleanup after 30 days of inactivity.

Changes

Private endpoint lifecycle

Layer / File(s)	Summary
Document endpoint lifecycle rules `tidb-cloud/set-up-sink-private-endpoint.md`, `tidb-cloud/premium/set-up-sink-private-endpoint-premium.md`	The guides document endpoint ownership, sharing, persistence after resource deletion, deletion restrictions while in use, and automatic cleanup after 30 days of inactivity.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to ae0ae

This is a localized documentation update adding private endpoint management tips, with no actionable merge-blocking risk remaining beyond normal checks and review.

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description explains the documentation changes and includes the required template sections, but it does not select the affected TiDB version. The PR objective states that the changes target the re…	Select the applicable version checkbox, at minimum v8.5, and confirm whether master also applies.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: adding private endpoint management tips.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Full details: Description check

Explanation

The description explains the documentation changes and includes the required template sections, but it does not select the affected TiDB version. The PR objective states that the changes target the release-8.5 branch.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 45879bcf-66a1-40e2-905a-f8fd82d77cec

📥 Commits

Reviewing files that changed from the base of the PR and between 7e1eca1 and 5c0f503.

📒 Files selected for processing (2)

tidb-cloud/premium/set-up-sink-private-endpoint-premium.md
tidb-cloud/set-up-sink-private-endpoint.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

ideascf

LGTM

ti-chi-bot · 2026-08-27T14:06:51Z

@ideascf: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

LGTM

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Co-authored-by: Grace Cai <qqzczy@126.com>

qiancai · 2026-08-28T07:23:40Z

/approve

ti-chi-bot · 2026-08-28T07:23:50Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [qiancai]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Add private endpoint management tips.

5c0f503

ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 26, 2026

ginkgoch self-assigned this Aug 26, 2026

coderabbitai Bot reviewed Aug 26, 2026

View reviewed changes

Comment thread tidb-cloud/set-up-sink-private-endpoint.md Outdated

Add same region restriction

894b7e4

ideascf approved these changes Aug 27, 2026

View reviewed changes

qiancai reviewed Aug 27, 2026

View reviewed changes

Comment thread tidb-cloud/premium/set-up-sink-private-endpoint-premium.md Outdated

Comment thread tidb-cloud/premium/set-up-sink-private-endpoint-premium.md

qiancai self-assigned this Aug 27, 2026

qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. and removed missing-translation-status This PR does not have translation status info. labels Aug 27, 2026

Apply suggestion from @qiancai

ae0ae78

Co-authored-by: Grace Cai <qqzczy@126.com>

qiancai reviewed Aug 28, 2026

View reviewed changes

Comment thread tidb-cloud/premium/set-up-sink-private-endpoint-premium.md Outdated

Comment thread tidb-cloud/set-up-sink-private-endpoint.md Outdated

ginkgoch and others added 2 commits August 28, 2026 15:19

Apply suggestion from @qiancai

e6bdacc

Co-authored-by: Grace Cai <qqzczy@126.com>

Apply suggestion from @qiancai

a567b7d

Co-authored-by: Grace Cai <qqzczy@126.com>

ti-chi-bot Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 28, 2026

qiancai added the lgtm label Aug 28, 2026

ti-chi-bot Bot added the approved label Aug 28, 2026

ti-chi-bot Bot merged commit 965cdb9 into pingcap:release-8.5 Aug 28, 2026
12 checks passed

Navigation Menu

Uh oh!

Add private endpoint management tips. - #23612

Add private endpoint management tips.#23612
ti-chi-bot[bot] merged 5 commits into
pingcap:release-8.5from
ginkgoch:private-endpoint-recycle-policy

ginkgoch commented Aug 26, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 26, 2026 •

edited

Loading

Reviews paused

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

ideascf left a comment

Uh oh!

ti-chi-bot Bot commented Aug 27, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qiancai commented Aug 28, 2026

Uh oh!

ti-chi-bot Bot commented Aug 28, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

ginkgoch commented Aug 26, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

AI agent involvement

Do your changes match any of the following descriptions?

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ideascf left a comment

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot Bot commented Aug 27, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qiancai commented Aug 28, 2026

Uh oh!

ti-chi-bot Bot commented Aug 28, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ginkgoch commented Aug 26, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 26, 2026 •

edited

Loading